Detailed employee information

This request is used to get detailed information about the client's employee.

Request syntax

GET https://b2b-api.go.yandex.ru/integration/2.0/users?user_id={user ID}

Request headers

  • Authorization: Bearer <OAuth-token>
    OAuth access token. The steps to get a token are described in Getting started.
  • X-YaTaxi-Selected-Corp-Client-Id — client ID from the account. Required if multiple clients are available using the token.

Request parameters

The request contains the following required parameter:

  • user_id: the ID of the employee for whom the information is being provided.

Response field description

Responses may contain the following fields:

Field Description Format
fullname The employee's full name. String
is_active Indicates that the employee is active. An inactive employee can't place an order and rides can't be ordered in their name. Boolean
phone The employee's phone number. String
id The employee's ID. String
is_deleted Indicates whether the employee was archived. Boolean
cost_center Cost center. String
cost_centers_id ID of the cost center settings, if the client has new cost centers. Optional field. String
department_id ID of the department in your account. String
limits The limits on the amount the employee can spend on a specific service in a calendar month. An array of elements that contains a separate element for each service.
nickname The employee's short name. In the interface of the Corporate Client Dashboard, it is the ID field in the external system. String
email The employee's email address. String
client_id ID of the client. String

Structure of the limits array element:

Field

Description

Format

Required

limit_id

The ID of a previously created limit. This ID will be assigned to a user.

String

Yes

service

The service name. Acceptable values:

  • taxi: Yandex Go;

  • eats2: Yandex Eats and Yandex Grocery;

  • grocery: Yandex Grocery;

  • drive: Car sharing;

  • tanker: Yandex Fuel;

  • cargo: Cargo transportation;

  • travel: Yandex Travel;

  • scooters: Yandex Scooters.

String

Yes

Request example

GET https://b2b-api.go.yandex.ru/integration/2.0/users?user_id=f65...c57d
...
Authorization: Bearer <OAuth token>

Response example

An example response to this request looks like this:

{
  "fullname": "Ilya Ivanov",
  "is_active": true,
  "phone": "+79262770203",
  "id": "2e….b6",
  "is_deleted": false,
  "cost_center": "",
  "cost_centers_id": "2c53…1",
  "department_id": "b617…4",
  "limits": [
     {
       "limit_id": "d4c...8",
       "service": "taxi"
     },
     {
       "limit_id": "473…8",
       "service": "eats2"
     },
     {
       "limit_id": "df…f",
       "service": "cargo"
     }
     ],
  "nickname": "",
  "client_id": "bee…c" 
}

Response codes

The response to this request may contain the following standard HTTP codes:

  • 200: Request completed successfully.
  • 401: The OAuth token is incorrect.
  • 403: The client doesn't have sufficient rights to run this request.
    • SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header X-YaTaxi-Selected-Corp-Client-Id (returned if more than one client is available for the token).
    • SELECTED_CLIENT_ACCESS_DENIED: the header X-YaTaxi-Selected-Corp-Client-Id contains the client's ID, which this login does not have access to.
  • 404: The requested record wasn't found.

combined service

the service is outdated, use eats2

Hotels

Previous
Archive employee
Next
Detailed employee information by his phone number